Introdução a API

Author: GoodWe Brazil

2024-09-23 16:42

O QUE É API?

O termo API (Application Programming Interface) significa interface de programação de aplicativos, o que permite que as empresas abram os dados e a funcionalidade de suas aplicações para que desenvolvedores externos e parceiros de negócios possam acessar. Isso permite que dois aplicativos, o do fabricante e o de terceiros se comuniquem por meio de uma interface documentada, sem que seja necessário saber como eles são implementados. Conforme é visto na figura 1 abaixo, na prática, a API se torna uma espécie de ponte para acesso dos dados do banco de dados do sistema de monitoramento da GoodWe, o portal SEMS. Sendo assim, clientes e/ou parceiros de negócio podem desenvolver programas para acessar essa ponte e obter dados da aplicação que foi desenvolvida pela GoodWe.

 

A GoodWe fornece o serviço de API para estabelecer a comunicação de dados com clientes ou terceiros por meio da plataforma de monitoramento SEMS, assim como o serviço de API através de protocolo HTTPS e KAFKA. Em comparação com o serviço de transmissão de dados, que transfere apenas os dados brutos com base nos registros disponíveis do protocolo Modbus RTU do inversor, o serviço de API pode fornecer tanto os dados brutos quanto os dados comerciais processados pelo SEMS. Existem três tipos diferentes de API disponíveis para os clientes, de acordo com diferentes cenários ou requisitos de aplicativos: API Aberta, API de Dados em Tempo Real e API de Controle Remoto em Lote. Funcionalmente, a API Aberta foca no processamento de dados através da plataforma SEMS para solicitações de clientes, a API de dados em tempo real foca no envio de dados brutos diretamente para o cliente, e a interface de controle remoto em lote se aplica ao envio de comandos remotamente para o inversor.

 

1- API ABERTA (OPEN API)

A API aberta está disponível apenas aos usuários que possuem uma conta corporativa no portal SEMS, o sistema de monitoramento da GoodWe. Com este serviço de API aberta, os usuários podem obter acesso a todos os dispositivos locais e realizar a chamada de dados e até o controle remoto de inversores. Além disso, a API aberta suporta a chamada de dados de registradores, por exemplo, de estação meteorológica, do SEC1000 e do HomeKit. Esta API usa o protocolo HTTPS para acessar os dados e definir os comandos de controle. Dessa forma, a GoodWe envia os dados para o endereço HTTP fornecido pelo cliente, que é um para um e ponto a ponto. Dentro desta API existem 31 interfaces para acessar diferentes tipos de dados que podem ser divididas em 4 formas: interface da planta, interface do dispositivo, interface de controle remoto e interface do registrador de dados, que podem ser visualizadas na tabela 1 abaixo.

 

 

Os usuários podem controlar remotamente os inversores, inclusive definir os parâmetros ou as funções, de acordo com as diferentes interfaces. No entanto, a API aberta não oferece a função de atualização de firmware. Para tal, os usuários que possuem acesso ao serviço de API aberta também possuem contas da organização SEMS e podem solicitar acesso da plataforma de gerenciamento inteligente da GoodWe, a plataforma IoT, pois dessa forma as contas da organização terão acesso ao recurso de atualização remota de firmware. Ainda, é importante ressaltar que existe um limite para frequência de chamada de dados quando o usuário está acessando esta API aberta. Portanto, o cliente e/ou parceiro de negócio deve entender as diferenças entra a API aberta e as APIs em que a transmissão de dados em tempo real (API de dados em tempo real e API de controle remoto em lote), conforme é demostrado na figura 2 abaixo:

 

 

Para mais detalhes, por favor baixe o arquivo abaixo. 

Download